Demographic API (latest)
Management of the AGENT and the associated VERSIONED_AGENT resource.
Create AGENT
Creates the first version of a new AGENT.
header Parameters
| Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The AGENT.
| _type | string Value: "AGENT" |
required | any (DV_TEXT) |
| archetype_node_id required | string |
any (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
required | Array of objects (PARTY_IDENTITY) |
Array of objects (CONTACT) | |
| details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE type details. |
Array of objects (PARTY_RELATIONSHIP) | |
Array of any (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Response samples
- 201
- 400
{- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Get AGENT
Retrieves a version of the AGENT identified by uid_based_id.
The uid_based_id can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a version_uid), or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).
The former is used to retrieve a specific known version of the AGENT (e.g. one identified by 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1), whereas the later (e.g. an identifier like 8849182c-82ad-4088-a07f-48ead4180515) is be used to retrieve a version from the version container whenever the version_tree_id is unknown or irrelevant (such as when most recent version is requested).
When the uid_based_id has the form of a HIER_OBJECT_ID, if the version_at_time is supplied, retrieves the version extant at specified time, otherwise retrieves the latest AGENT version.
See Resource identification for more details about the identifiers usage and meaning.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An abstract identifier: it can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
query Parameters
| version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Update AGENT
Updates AGENT identified by uid_based_id.
The uid_based_id can take only a form of an HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).
If the request body already contains a AGENT.uid.value, it must match the uid_based_id in the URL.
The existing latest version_uid of AGENT resource (i.e. the preceding_version_uid) must be specified in the If-Match header.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515 An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a |
header Parameters
| If-Match required | string Example: "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::1" Header to make the request conditional.
Together with |
| Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The new AGENT.
| _type | string Value: "AGENT" |
required | any (DV_TEXT) |
| archetype_node_id required | string |
any (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
required | Array of objects (PARTY_IDENTITY) |
Array of objects (CONTACT) | |
| details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE type details. |
Array of objects (PARTY_RELATIONSHIP) | |
Array of any (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Response samples
- 200
- 400
{- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Delete AGENT
Deletes the AGENT identified by uid_based_id.
The uid_based_id MUST be in a form of an OBJECT_VERSION_ID identifier taken from the last (most recent) VERSION.uid.value, representing the preceding_version_uid to be deleted.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An identifier in a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
Responses
Get versioned AGENT
Retrieves a VERSIONED_AGENT identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_AGENT identifier taken from VERSIONED_AGENT.uid.value. |
Responses
Response samples
- 200
{- "uid": {
- "value": "8849182c-82ad-4088-a07f-48ead4180515"
}, - "owner_id": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "7d44b88c-4199-4bad-97dc-d78268e01398"
}, - "namespace": "local",
- "type": "SYSTEM"
}, - "time_created": {
- "value": "2015-01-20T19:30:22.765+01:00"
}
}Get versioned AGENT revision history
Retrieves revision history of the VERSIONED_AGENT identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_AGENT identifier taken from VERSIONED_AGENT.uid.value. |
Responses
Response samples
- 200
{- "items": [
- {
- "version_id": {
- "value": "8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1"
}, - "audits": [
- {
- "system_id": "d60e2348-b083-48ce-93b9-916cef1d3a5a",
- "time_committed": {
- "value": "2015-01-20T19:30:22.765+01:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "An optional description string"
}, - "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}
}
]
}
]
}Get versioned AGENT version at time
Retrieves a VERSION from the VERSIONED_AGENT identified by versioned_object_uid.
If version_at_time is supplied, retrieves the VERSION extant at specified time, otherwise retrieves the latest VERSION.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_AGENT identifier taken from VERSIONED_AGENT.uid.value. |
query Parameters
| version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "ORIGINAL_VERSION",
- "contribution": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "namespace": "local",
- "type": "CONTRIBUTION"
}, - "signature": "string",
- "commit_audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}, - "data": {
- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}, - "uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "preceding_version_uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "other_input_version_uids": [
- {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}
], - "lifecycle_state": {
- "value": "Coded text value",
- "defining_code": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}
}, - "attestations": [
- {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
]
}Get versioned AGENT version by id
Retrieves a VERSION identified by version_uid of a VERSIONED_AGENT identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_AGENT identifier taken from VERSIONED_AGENT.uid.value. |
| version_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2 VERSION identifier taken from VERSION.uid.value. |
Responses
Response samples
- 200
{- "_type": "ORIGINAL_VERSION",
- "contribution": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "namespace": "local",
- "type": "CONTRIBUTION"
}, - "signature": "string",
- "commit_audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}, - "data": {
- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}, - "uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "preceding_version_uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "other_input_version_uids": [
- {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}
], - "lifecycle_state": {
- "value": "Coded text value",
- "defining_code": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}
}, - "attestations": [
- {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
]
}Management of the GROUP and the associated VERSIONED_GROUP resource.
Create GROUP
Creates the first version of a new GROUP.
header Parameters
| Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The GROUP.
| _type | string Value: "GROUP" |
required | any (DV_TEXT) |
| archetype_node_id required | string |
any (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
required | Array of objects (PARTY_IDENTITY) |
Array of objects (CONTACT) | |
| details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE type details. |
Array of objects (PARTY_RELATIONSHIP) | |
Array of any (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Response samples
- 201
- 400
{- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Get GROUP
Retrieves a version of the GROUP identified by uid_based_id.
The uid_based_id can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a version_uid), or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).
The former is used to retrieve a specific known version of the GROUP (e.g. one identified by 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1), whereas the later (e.g. an identifier like 8849182c-82ad-4088-a07f-48ead4180515) is be used to retrieve a version from the version container whenever the version_tree_id is unknown or irrelevant (such as when most recent version is requested).
When the uid_based_id has the form of a HIER_OBJECT_ID, if the version_at_time is supplied, retrieves the version extant at specified time, otherwise retrieves the latest GROUP version.
See Resource identification for more details about the identifiers usage and meaning.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An abstract identifier: it can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
query Parameters
| version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Update GROUP
Updates GROUP identified by uid_based_id.
The uid_based_id can take only a form of an HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).
If the request body already contains a GROUP.uid.value, it must match the uid_based_id in the URL.
The existing latest version_uid of GROUP resource (i.e. the preceding_version_uid) must be specified in the If-Match header.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515 An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a |
header Parameters
| If-Match required | string Example: "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::1" Header to make the request conditional.
Together with |
| Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The new GROUP.
| _type | string Value: "GROUP" |
required | any (DV_TEXT) |
| archetype_node_id required | string |
any (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
required | Array of objects (PARTY_IDENTITY) |
Array of objects (CONTACT) | |
| details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE type details. |
Array of objects (PARTY_RELATIONSHIP) | |
Array of any (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Response samples
- 200
- 400
{- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Delete GROUP
Deletes the GROUP identified by uid_based_id.
The uid_based_id MUST be in a form of an OBJECT_VERSION_ID identifier taken from the last (most recent) VERSION.uid.value, representing the preceding_version_uid to be deleted.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An identifier in a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
Responses
Get versioned GROUP
Retrieves a VERSIONED_GROUP identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_GROUP identifier taken from VERSIONED_GROUP.uid.value. |
Responses
Response samples
- 200
{- "uid": {
- "value": "8849182c-82ad-4088-a07f-48ead4180515"
}, - "owner_id": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "7d44b88c-4199-4bad-97dc-d78268e01398"
}, - "namespace": "local",
- "type": "SYSTEM"
}, - "time_created": {
- "value": "2015-01-20T19:30:22.765+01:00"
}
}Get versioned GROUP revision history
Retrieves revision history of the VERSIONED_GROUP identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_GROUP identifier taken from VERSIONED_GROUP.uid.value. |
Responses
Response samples
- 200
{- "items": [
- {
- "version_id": {
- "value": "8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1"
}, - "audits": [
- {
- "system_id": "d60e2348-b083-48ce-93b9-916cef1d3a5a",
- "time_committed": {
- "value": "2015-01-20T19:30:22.765+01:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "An optional description string"
}, - "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}
}
]
}
]
}Get versioned GROUP version at time
Retrieves a VERSION from the VERSIONED_GROUP identified by versioned_object_uid.
If version_at_time is supplied, retrieves the VERSION extant at specified time, otherwise retrieves the latest VERSION.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_GROUP identifier taken from VERSIONED_GROUP.uid.value. |
query Parameters
| version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "ORIGINAL_VERSION",
- "contribution": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "namespace": "local",
- "type": "CONTRIBUTION"
}, - "signature": "string",
- "commit_audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}, - "data": {
- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}, - "uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "preceding_version_uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "other_input_version_uids": [
- {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}
], - "lifecycle_state": {
- "value": "Coded text value",
- "defining_code": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}
}, - "attestations": [
- {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
]
}Get versioned GROUP version by id
Retrieves a VERSION identified by version_uid of a VERSIONED_GROUP identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_GROUP identifier taken from VERSIONED_GROUP.uid.value. |
| version_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2 VERSION identifier taken from VERSION.uid.value. |
Responses
Response samples
- 200
{- "_type": "ORIGINAL_VERSION",
- "contribution": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "namespace": "local",
- "type": "CONTRIBUTION"
}, - "signature": "string",
- "commit_audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}, - "data": {
- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}, - "uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "preceding_version_uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "other_input_version_uids": [
- {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}
], - "lifecycle_state": {
- "value": "Coded text value",
- "defining_code": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}
}, - "attestations": [
- {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
]
}Management of the ORGANISATION and the associated VERSIONED_ORGANISATION resource.
Create ORGANISATION
Creates the first version of a new ORGANISATION.
header Parameters
| Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The ORGANISATION.
| _type | string Value: "ORGANISATION" |
required | any (DV_TEXT) |
| archetype_node_id required | string |
any (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
required | Array of objects (PARTY_IDENTITY) |
Array of objects (CONTACT) | |
| details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE type details. |
Array of objects (PARTY_RELATIONSHIP) | |
Array of any (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Response samples
- 201
- 400
{- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Get ORGANISATION
Retrieves a version of the ORGANISATION identified by uid_based_id.
The uid_based_id can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a version_uid), or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).
The former is used to retrieve a specific known version of the ORGANISATION (e.g. one identified by 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1), whereas the later (e.g. an identifier like 8849182c-82ad-4088-a07f-48ead4180515) is be used to retrieve a version from the version container whenever the version_tree_id is unknown or irrelevant (such as when most recent version is requested).
When the uid_based_id has the form of a HIER_OBJECT_ID, if the version_at_time is supplied, retrieves the version extant at specified time, otherwise retrieves the latest ORGANISATION version.
See Resource identification for more details about the identifiers usage and meaning.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An abstract identifier: it can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
query Parameters
| version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Update ORGANISATION
Updates ORGANISATION identified by uid_based_id.
The uid_based_id can take only a form of an HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).
If the request body already contains a ORGANISATION.uid.value, it must match the uid_based_id in the URL.
The existing latest version_uid of ORGANISATION resource (i.e. the preceding_version_uid) must be specified in the If-Match header.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515 An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a |
header Parameters
| If-Match required | string Example: "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::1" Header to make the request conditional.
Together with |
| Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The new ORGANISATION.
| _type | string Value: "ORGANISATION" |
required | any (DV_TEXT) |
| archetype_node_id required | string |
any (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
required | Array of objects (PARTY_IDENTITY) |
Array of objects (CONTACT) | |
| details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE type details. |
Array of objects (PARTY_RELATIONSHIP) | |
Array of any (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Response samples
- 200
- 400
{- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Delete ORGANISATION
Deletes the ORGANISATION identified by uid_based_id.
The uid_based_id MUST be in a form of an OBJECT_VERSION_ID identifier taken from the last (most recent) VERSION.uid.value, representing the preceding_version_uid to be deleted.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An identifier in a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
Responses
Get versioned ORGANISATION
Retrieves a VERSIONED_ORGANISATION identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_ORGANISATION identifier taken from VERSIONED_ORGANISATION.uid.value. |
Responses
Response samples
- 200
{- "uid": {
- "value": "8849182c-82ad-4088-a07f-48ead4180515"
}, - "owner_id": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "7d44b88c-4199-4bad-97dc-d78268e01398"
}, - "namespace": "local",
- "type": "SYSTEM"
}, - "time_created": {
- "value": "2015-01-20T19:30:22.765+01:00"
}
}Get versioned ORGANISATION revision history
Retrieves revision history of the VERSIONED_ORGANISATION identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_ORGANISATION identifier taken from VERSIONED_ORGANISATION.uid.value. |
Responses
Response samples
- 200
{- "items": [
- {
- "version_id": {
- "value": "8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1"
}, - "audits": [
- {
- "system_id": "d60e2348-b083-48ce-93b9-916cef1d3a5a",
- "time_committed": {
- "value": "2015-01-20T19:30:22.765+01:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "An optional description string"
}, - "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}
}
]
}
]
}Get versioned ORGANISATION version at time
Retrieves a VERSION from the VERSIONED_ORGANISATION identified by versioned_object_uid.
If version_at_time is supplied, retrieves the VERSION extant at specified time, otherwise retrieves the latest VERSION.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_ORGANISATION identifier taken from VERSIONED_ORGANISATION.uid.value. |
query Parameters
| version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "ORIGINAL_VERSION",
- "contribution": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "namespace": "local",
- "type": "CONTRIBUTION"
}, - "signature": "string",
- "commit_audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}, - "data": {
- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}, - "uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "preceding_version_uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "other_input_version_uids": [
- {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}
], - "lifecycle_state": {
- "value": "Coded text value",
- "defining_code": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}
}, - "attestations": [
- {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
]
}Get versioned ORGANISATION version by id
Retrieves a VERSION identified by version_uid of a VERSIONED_ORGANISATION identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_ORGANISATION identifier taken from VERSIONED_ORGANISATION.uid.value. |
| version_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2 VERSION identifier taken from VERSION.uid.value. |
Responses
Response samples
- 200
{- "_type": "ORIGINAL_VERSION",
- "contribution": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "namespace": "local",
- "type": "CONTRIBUTION"
}, - "signature": "string",
- "commit_audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}, - "data": {
- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}, - "uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "preceding_version_uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "other_input_version_uids": [
- {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}
], - "lifecycle_state": {
- "value": "Coded text value",
- "defining_code": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}
}, - "attestations": [
- {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
]
}Management of the PERSON and the associated VERSIONED_PERSON resource.
Create PERSON
Creates the first version of a new PERSON.
header Parameters
| Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The PERSON.
| _type | string Value: "PERSON" |
required | any (DV_TEXT) |
| archetype_node_id required | string |
any (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
required | Array of objects (PARTY_IDENTITY) |
Array of objects (CONTACT) | |
| details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE type details. |
Array of objects (PARTY_RELATIONSHIP) | |
Array of any (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "PERSON",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Response samples
- 201
- 400
{- "_type": "PERSON",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Get PERSON
Retrieves a version of the PERSON identified by uid_based_id.
The uid_based_id can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a version_uid), or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).
The former is used to retrieve a specific known version of the PERSON (e.g. one identified by 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1), whereas the later (e.g. an identifier like 8849182c-82ad-4088-a07f-48ead4180515) is be used to retrieve a version from the version container whenever the version_tree_id is unknown or irrelevant (such as when most recent version is requested).
When the uid_based_id has the form of a HIER_OBJECT_ID, if the version_at_time is supplied, retrieves the version extant at specified time, otherwise retrieves the latest PERSON version.
See Resource identification for more details about the identifiers usage and meaning.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An abstract identifier: it can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
query Parameters
| version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "PERSON",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Update PERSON
Updates PERSON identified by uid_based_id.
The uid_based_id can take only a form of an HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).
If the request body already contains a PERSON.uid.value, it must match the uid_based_id in the URL.
The existing latest version_uid of PERSON resource (i.e. the preceding_version_uid) must be specified in the If-Match header.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515 An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a |
header Parameters
| If-Match required | string Example: "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::1" Header to make the request conditional.
Together with |
| Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The new PERSON.
| _type | string Value: "PERSON" |
required | any (DV_TEXT) |
| archetype_node_id required | string |
any (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
required | Array of objects (PARTY_IDENTITY) |
Array of objects (CONTACT) | |
| details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE type details. |
Array of objects (PARTY_RELATIONSHIP) | |
Array of any (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "PERSON",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Response samples
- 200
- 400
{- "_type": "PERSON",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}Delete PERSON
Deletes the PERSON identified by uid_based_id.
The uid_based_id MUST be in a form of an OBJECT_VERSION_ID identifier taken from the last (most recent) VERSION.uid.value, representing the preceding_version_uid to be deleted.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An identifier in a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
Responses
Get versioned PERSON
Retrieves a VERSIONED_PERSON identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_PERSON identifier taken from VERSIONED_PERSON.uid.value. |
Responses
Response samples
- 200
{- "uid": {
- "value": "8849182c-82ad-4088-a07f-48ead4180515"
}, - "owner_id": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "7d44b88c-4199-4bad-97dc-d78268e01398"
}, - "namespace": "local",
- "type": "SYSTEM"
}, - "time_created": {
- "value": "2015-01-20T19:30:22.765+01:00"
}
}Get versioned PERSON revision history
Retrieves revision history of the VERSIONED_PERSON identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_PERSON identifier taken from VERSIONED_PERSON.uid.value. |
Responses
Response samples
- 200
{- "items": [
- {
- "version_id": {
- "value": "8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1"
}, - "audits": [
- {
- "system_id": "d60e2348-b083-48ce-93b9-916cef1d3a5a",
- "time_committed": {
- "value": "2015-01-20T19:30:22.765+01:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "An optional description string"
}, - "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}
}
]
}
]
}Get versioned PERSON version at time
Retrieves a VERSION from the VERSIONED_PERSON identified by versioned_object_uid.
If version_at_time is supplied, retrieves the VERSION extant at specified time, otherwise retrieves the latest VERSION.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_PERSON identifier taken from VERSIONED_PERSON.uid.value. |
query Parameters
| version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "ORIGINAL_VERSION",
- "contribution": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "namespace": "local",
- "type": "CONTRIBUTION"
}, - "signature": "string",
- "commit_audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}, - "data": {
- "_type": "PERSON",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}, - "uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "preceding_version_uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "other_input_version_uids": [
- {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}
], - "lifecycle_state": {
- "value": "Coded text value",
- "defining_code": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}
}, - "attestations": [
- {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
]
}Get versioned PERSON version by id
Retrieves a VERSION identified by version_uid of a VERSIONED_PERSON identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_PERSON identifier taken from VERSIONED_PERSON.uid.value. |
| version_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2 VERSION identifier taken from VERSION.uid.value. |
Responses
Response samples
- 200
{- "_type": "ORIGINAL_VERSION",
- "contribution": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "namespace": "local",
- "type": "CONTRIBUTION"
}, - "signature": "string",
- "commit_audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}, - "data": {
- "_type": "PERSON",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}, - "uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "preceding_version_uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "other_input_version_uids": [
- {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}
], - "lifecycle_state": {
- "value": "Coded text value",
- "defining_code": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}
}, - "attestations": [
- {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
]
}Management of the ROLE and the associated VERSIONED_ROLE resource.
Create ROLE
Creates the first version of a new ROLE.
header Parameters
| Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The ROLE.
| _type | string Value: "ROLE" |
required | any (DV_TEXT) |
| archetype_node_id required | string |
any (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
required | Array of objects (PARTY_IDENTITY) |
Array of objects (CONTACT) | |
| details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE type details. |
Array of objects (PARTY_RELATIONSHIP) | |
object (DV_INTERVAL_of_DATE) | |
required | object (PARTY_REF) Identifier for parties in a demographic or identity service. |
Array of objects (CAPABILITY) |
Responses
Request samples
- Payload
{- "_type": "ROLE",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}, - "performer": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "capabilities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "credentials": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
]
}Response samples
- 201
- 400
{- "_type": "ROLE",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}, - "performer": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "capabilities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "credentials": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
]
}Get ROLE
Retrieves a version of the ROLE identified by uid_based_id.
The uid_based_id can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a version_uid), or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).
The former is used to retrieve a specific known version of the ROLE (e.g. one identified by 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1), whereas the later (e.g. an identifier like 8849182c-82ad-4088-a07f-48ead4180515) is be used to retrieve a version from the version container whenever the version_tree_id is unknown or irrelevant (such as when most recent version is requested).
When the uid_based_id has the form of a HIER_OBJECT_ID, if the version_at_time is supplied, retrieves the version extant at specified time, otherwise retrieves the latest ROLE version.
See Resource identification for more details about the identifiers usage and meaning.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An abstract identifier: it can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
query Parameters
| version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "ROLE",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}, - "performer": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "capabilities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "credentials": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
]
}Update ROLE
Updates ROLE identified by uid_based_id.
The uid_based_id can take only a form of an HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).
If the request body already contains a ROLE.uid.value, it must match the uid_based_id in the URL.
The existing latest version_uid of ROLE resource (i.e. the preceding_version_uid) must be specified in the If-Match header.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515 An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a |
header Parameters
| If-Match required | string Example: "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::1" Header to make the request conditional.
Together with |
| Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The new ROLE.
| _type | string Value: "ROLE" |
required | any (DV_TEXT) |
| archetype_node_id required | string |
any (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
required | Array of objects (PARTY_IDENTITY) |
Array of objects (CONTACT) | |
| details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE type details. |
Array of objects (PARTY_RELATIONSHIP) | |
object (DV_INTERVAL_of_DATE) | |
required | object (PARTY_REF) Identifier for parties in a demographic or identity service. |
Array of objects (CAPABILITY) |
Responses
Request samples
- Payload
{- "_type": "ROLE",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}, - "performer": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "capabilities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "credentials": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
]
}Response samples
- 200
- 400
{- "_type": "ROLE",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}, - "performer": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "capabilities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "credentials": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
]
}Delete ROLE
Deletes the ROLE identified by uid_based_id.
The uid_based_id MUST be in a form of an OBJECT_VERSION_ID identifier taken from the last (most recent) VERSION.uid.value, representing the preceding_version_uid to be deleted.
path Parameters
| uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An identifier in a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
Responses
Get versioned ROLE
Retrieves a VERSIONED_ROLE identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_ROLE identifier taken from VERSIONED_ROLE.uid.value. |
Responses
Response samples
- 200
{- "uid": {
- "value": "8849182c-82ad-4088-a07f-48ead4180515"
}, - "owner_id": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "7d44b88c-4199-4bad-97dc-d78268e01398"
}, - "namespace": "local",
- "type": "SYSTEM"
}, - "time_created": {
- "value": "2015-01-20T19:30:22.765+01:00"
}
}Get versioned ROLE revision history
Retrieves revision history of the VERSIONED_ROLE identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_ROLE identifier taken from VERSIONED_ROLE.uid.value. |
Responses
Response samples
- 200
{- "items": [
- {
- "version_id": {
- "value": "8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1"
}, - "audits": [
- {
- "system_id": "d60e2348-b083-48ce-93b9-916cef1d3a5a",
- "time_committed": {
- "value": "2015-01-20T19:30:22.765+01:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "An optional description string"
}, - "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}
}
]
}
]
}Get versioned ROLE version at time
Retrieves a VERSION from the VERSIONED_ROLE identified by versioned_object_uid.
If version_at_time is supplied, retrieves the VERSION extant at specified time, otherwise retrieves the latest VERSION.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_ROLE identifier taken from VERSIONED_ROLE.uid.value. |
query Parameters
| version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "ORIGINAL_VERSION",
- "contribution": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "namespace": "local",
- "type": "CONTRIBUTION"
}, - "signature": "string",
- "commit_audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}, - "data": {
- "_type": "ROLE",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}, - "performer": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "capabilities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "credentials": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
]
}, - "uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "preceding_version_uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "other_input_version_uids": [
- {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}
], - "lifecycle_state": {
- "value": "Coded text value",
- "defining_code": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}
}, - "attestations": [
- {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
]
}Get versioned ROLE version by id
Retrieves a VERSION identified by version_uid of a VERSIONED_ROLE identified by versioned_object_uid.
path Parameters
| versioned_object_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b VERSIONED_ROLE identifier taken from VERSIONED_ROLE.uid.value. |
| version_uid required | string Example: 6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2 VERSION identifier taken from VERSION.uid.value. |
Responses
Response samples
- 200
{- "_type": "ORIGINAL_VERSION",
- "contribution": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "namespace": "local",
- "type": "CONTRIBUTION"
}, - "signature": "string",
- "commit_audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}, - "data": {
- "_type": "ROLE",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "contacts": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "addresses": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "details": { }
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "details": { },
- "relationships": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "source": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "target": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "details": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
], - "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}, - "performer": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}, - "capabilities": [
- {
- "_type": "string",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "credentials": { },
- "time_validity": {
- "_type": "DV_INTERVAL",
- "lower_unbounded": true,
- "upper_unbounded": true,
- "lower_included": true,
- "upper_included": true,
- "lower": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}, - "upper": {
- "_type": "DV_DATE",
- "value": "2017-08-15"
}
}
}
]
}, - "uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "preceding_version_uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "other_input_version_uids": [
- {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}
], - "lifecycle_state": {
- "value": "Coded text value",
- "defining_code": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}
}, - "attestations": [
- {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
]
}Management of CONTRIBUTION resource.
Create CONTRIBUTION
We will use the relaxed CONTRIBUTION with the following optional attributes:
uid: when provided, it will be accepted in case is not in-use, otherwise error will be returnedaudit.time_committed: server will always set itaudit.system_id: when provided, it will be validated
header Parameters
| Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The CONTRIBUTION.
object (HIER_OBJECT_ID) | |
required | Array of objects (UPDATE_VERSION) |
required | object (UPDATE_AUDIT) The set of attributes required to document the committal of an information item to a repository. Used by the server to create an AUDIT_DETAILS object. |
Responses
Request samples
- Payload
{- "uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "versions": [
- {
- "preceding_version_uid": {
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}, - "signature": "string",
- "lifecycle_state": {
- "terminology_id": "snomed_ct",
- "code_string": "308335008"
}, - "attestations": [
- {
- "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": "openehr",
- "code_string": "249"
}
}, - "description": "Description text",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}
}
], - "data": { },
- "commit_audit": {
- "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": "openehr",
- "code_string": "249"
}
}, - "description": "Description text",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}
}
}
], - "audit": {
- "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": "openehr",
- "code_string": "249"
}
}, - "description": "Description text",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}
}
}Response samples
- 201
- 400
{- "uid": {
- "value": "0826851c-c4c2-4d61-92b9-410fb8275ff0"
}, - "versions": [
- {
- "_type": "OBJECT_REF",
- "id": {
- "_type": "OBJECT_VERSION_ID",
- "value": "fb458d9c-1323-42bc-b7f8-787f3660a0b5::openEHRSys.example.com::1"
}, - "namespace": "local",
- "type": "COMPOSITION"
}, - {
- "_type": "OBJECT_REF",
- "id": {
- "_type": "OBJECT_VERSION_ID",
- "value": "abcdefgh-1323-42bc-b7f8-787f3660a0ba::openEHRSys.example.com::1"
}, - "namespace": "local",
- "type": "FOLDER"
}
], - "audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
}Get CONTRIBUTION by id
Retrieves a CONTRIBUTION identified by contribution_uid.
path Parameters
| contribution_uid required | string Example: 0826851c-c4c2-4d61-92b9-410fb8275ff0 The CONTRIBUTION uid. |
Responses
Response samples
- 200
{- "uid": {
- "value": "0826851c-c4c2-4d61-92b9-410fb8275ff0"
}, - "versions": [
- {
- "_type": "OBJECT_REF",
- "id": {
- "_type": "OBJECT_VERSION_ID",
- "value": "fb458d9c-1323-42bc-b7f8-787f3660a0b5::openEHRSys.example.com::1"
}, - "namespace": "local",
- "type": "COMPOSITION"
}, - {
- "_type": "OBJECT_REF",
- "id": {
- "_type": "OBJECT_VERSION_ID",
- "value": "abcdefgh-1323-42bc-b7f8-787f3660a0ba::openEHRSys.example.com::1"
}, - "namespace": "local",
- "type": "FOLDER"
}
], - "audit": {
- "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
- "committer": {
- "_type": "PARTY_IDENTIFIED",
- "name": "A user name"
}, - "time_committed": {
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "change_type": {
- "value": "creation",
- "defining_code": {
- "terminology_id": {
- "value": "openehr"
}, - "code_string": "249"
}
}, - "description": {
- "value": "Description text"
}
}
}